Difference Method

Wintellect PowerCollections

previous page next page

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Computes the difference of this bag with another bag. The difference of these two bags is all items that appear in this bag, but not in otherBag. If an item appears X times in this bag, and Y times in the other bag, the difference contains the item X - Y times (zero times if Y >= X). A new bag is created with the difference of the bags and is returned. This bag and the other bag are unchanged.

Namespace: Wintellect.PowerCollections
Assembly: PowerCollections (in PowerCollections.dll)

Syntax

C#
public OrderedBag<T> Difference( OrderedBag<T> otherBag )

Visual Basic (Declaration)
Public Function Difference ( _ otherBag As OrderedBag(Of T) _ ) As OrderedBag(Of T)

Visual C++
public: OrderedBag<T>^ Difference ( OrderedBag<T>^ otherBag )

Parameters

otherBag: OrderedBag<(Of <T>)>
Bag to difference with.

Return Value

The difference of the two bags.

Remarks

The difference of two bags is computed in time O(M + N log M), where M is the size of the larger bag, and N is the size of the smaller bag.

Exceptions

Exception	Condition
System..::InvalidOperationException	This bag and otherBag don't use the same method for comparing items.
System..::ArgumentNullException	otherBag is null.